home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / bbs / develop.zip / 145INFO.DOC next >
Text File  |  1991-12-09  |  27KB  |  535 lines
  1.              PCBOARD UPDATE INFORMATION FOR THIRD PARTY DEVELOPERS
  2.              -----------------------------------------------------
  3.  
  4.               Copyright (C) 1990 by Clark Development Company, Inc
  5.          This information is provide for the sole purpose of providing
  6.        Third Party Authors with information to aid in the development of
  7.      PCBoard v14.5 add-on products.  All other uses are strictly forbidden.
  8.  
  9. GOAL:  One major goal in designing PCBoard v14.5 has been to make it compatible
  10.        with the prior releases of the version 14.x software - namely, v14.0,
  11.        v14.1 and v14.2.
  12.  
  13.        This goal includes the ability of v14.5 to read and write the same file
  14.        formats as used by all of the v14.x series of software.  It also means
  15.        that by using the same file formats many third party packages should be
  16.        able to be run UN-MODIFIED with the release of v14.5.
  17.  
  18.        There are, however, a few file changes which are required for version
  19.        14.5 and they will be detailed below.  As you will see - for the most
  20.        part the goal has been achieved in that v14.x will operate EVEN WITH
  21.        most of the file changes specified below and third party software
  22.        should continue to operate unmodified as well.
  23.  
  24.  
  25. PCBTEXT File
  26. ------------
  27. This file is the one exception to the rule and the goal expressed above.  You
  28. will need to keep a separate PCBTEXT file for v14.5 because it will not be
  29. entirely useable by v14.x software.
  30.  
  31. Just as in past releases of PCBoard - when new capabilities are added to the
  32. software it becomes necessary to add additional text strings to the end of the
  33. PCBTEXT file.  That is fine because each release knows the limit of the text
  34. records that it must access and so the additional entries are of no consequence
  35. to prior releases of PCBoard.
  36.  
  37. HOWEVER, the change that brings incompatibility to the v14.5 version of PCBTEXT
  38. is the ability of v14.5 to utilize an @-variable called @OPTEXT@ which means
  39. "operational text" to PCBoard.  For instance, previous releases of PCBoard may
  40. have included a line such as this in the PCBTEXT file:
  41.  
  42.    View executed on file ()
  43.  
  44. Previous releases of PCBoard would then "piece together" the appropriate text
  45. by substituting the "()" characters with the name of the file so that when it
  46. was displayed to the caller he saw "View executed on file (TEST.ZIP)" or
  47. something like that.  Version 14.5's MKPCBTXT replaces the above line in your
  48. PCBTEXT file with a line that looks like this:
  49.  
  50.    View executed on file (@OPTEXT@)
  51.  
  52. The above approach means that the '@OPTEXT@' variable may be placed anywhere on
  53. the line (increasing your flexibility in customizing the PCBTEXT file).
  54. However, that one change means that v14.2 and prior releases will no longer
  55. display the PCBTEXT entries properly.
  56.  
  57. Therefore, you should keep a copy of your v14.x PCBTEXT files separate from
  58. your converted PCBTEXT files for v14.5's usage on the off chance that you may
  59. need or want to go back to a prior release of PCBoard.
  60.  
  61. There is an additional new capability added to PCBTEXT which you can take
  62. advantage of in v14.5 that is not available in prior releases.  And that is
  63. the ability to have a PCBTEXT entry actually display a complete FILE to the
  64. caller rather than being limited to the one line entry in PCBTEXT.  You do this
  65. by using a Percent Sign in the followed by a filename.  Here is an example:
  66.  
  67.    The v14.2 PCBTEXT file has a line that says something like this:
  68.  
  69.       "Your time has been adjusted for an upcoming event"
  70.  
  71.    While it gets the job done - that of informing the caller that their time
  72.    has been adjusted - it doesn't give them very much information and being
  73.    only one line long is often ignored by the caller.  With v14.5 you can
  74.    change the above line to read like this:
  75.  
  76.       "%C:\PCB\GEN\EVENT.WRN"
  77.  
  78.    The percent sign tells v14.5 to display the FILE that immediately follows
  79.    it to the caller instead of displaying the text in PCBTEXT.  You could then
  80.    create a file on your system called EVENT.WRN with the following text:
  81.  
  82.      @FIRST@, your time has been adjusted to @TIMELEFT@ minutes due to an event
  83.      which is scheduled for @EVENT@.  If you call back after the event has
  84.      finished you'll receive the remainder of your daily time limit.
  85.  
  86. This brings up another usage for the @OPTEXT@ variable - it means that you can
  87. place the @OPTEXT@ variable inside of your file and have PCBoard perform the
  88. text substitution at the time the file is being displayed to the caller.  Here
  89. is another example:
  90.  
  91.    Version 14.2 has a line in PCBTEXT that says something like this:
  92.  
  93.      "Uploads Not Accepted on File Format ()"
  94.  
  95.    It then fills in the parenthesis with something like *.ARC if you have set
  96.    up your UPSEC file to not allow ARC files to be uploaded to your system.
  97.    With v14.5 you could replace the above line with this line and file:
  98.  
  99.      "%C:\PCB\GEN\BADUPLOAD.TXT"
  100.  
  101.      Sorry, @FIRST@, but this system will not accept files of the format
  102.      @OPTEXT@.  We prefer to keep all of our files in the ZIP format which
  103.      we feel is more compact than other compression methods.
  104.  
  105. In the above example the file BADUPLOAD.TXT will be displayed to the caller and
  106. the variable @OPTEXT@ will be substituted with the "*.ARC" that previous
  107. releases of PCBoard would have placed within the parenthesis of the old text.
  108.  
  109. Sometimes a PCBTEXT entry will be written to the callers log and other times
  110. the entry is actually a question that gets displayed to the caller.  You can
  111. still utilitize the "%" operator above by adhering to the following rules:
  112.  
  113.     1) If a %filespec is followed by a space and then more text then the
  114.        additional text after the filespec will be displayed to the caller.
  115.        Example (replacing "leave comment for sysop"):
  116.  
  117.           %C:\PCB\GEN\COMMENT Do you want to leave a comment
  118.  
  119.        The file C:\PCB\GEN\COMMENT might explain to the caller that you'd
  120.        prefer that messages be addressed to ALL and after the file is
  121.        displayed it will then ask him "Do you want to leave a comment?".
  122.  
  123.     2) If the %filespec is followed by a PLUS sign and then more text then the
  124.        additional text will be written to the callers log but it will NOT be
  125.        displayed to the caller.  Example (replacing "file not found");
  126.  
  127.           %C:\PCB\GEN\NOTFOUND @OPTEXT@
  128.  
  129.        In this example the file C:\PCB\GEN\NOTFOUND will be displayed to the
  130.        caller and then %C:\PCB\GEN\NOTFOUND filename will be written to
  131.        the callers log where "filename" is the name of the file not found.
  132.  
  133.  
  134. PCBOARD.DAT File
  135. ----------------
  136. This file is created by PCBSETUP and hopefully by no other software out there
  137. (meaning: third party authors should *not* be writing to this file).
  138.  
  139. There are new entries at the END of the file which are used by PCBoard v14.5
  140. in place of the environment variables used by previous releases of PCBoard.
  141.  
  142. The first time you run PCBSETUP on an old v14.0 formatted file it will warn
  143. you that it is about to convert the environment variables and create a new
  144. PCBOARD.DAT file which will actually not be written to disk until you tell
  145. PCBSetup to save the file.  These new entries are:
  146.  
  147.     Line 151:  Security Level needed for USERS command
  148.     Line 152:  Security Level needed for WHO command
  149.     Line 153:  Security Level needed for BATCH file transfers
  150.     Line 154:  Name of color definition file (usually PCBFILER.DEF)
  151.     Line 155:  Lowest allowed baud rate for callers (was /BAUD:xxxx)
  152.     Line 156:  Modem delay during recycle (was /DELAY:xx)
  153.     Line 157:  Number of Rings before answering the phone
  154.     Line 158:  IRQ number of comm port if not COM1 or COM2
  155.     Line 159:  BASE address of comm port if not COM1 or COM2
  156.     Line 160:  Leave DTR up at drop to DOS (some modems hangup if DTR is down)
  157.     Line 161:  Maximum lines in scrollback buffer (was /MAX:xxx)
  158.     Line 162:  Pre-load PCBTEXT file for faster access (uses more memory)
  159.     Line 163:  Pre-load CNAMES file for faster access (uses more memory)
  160.     Line 164:  Secu